home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / IDLIncludes / TextInputSystem.idl < prev    next >
Text File  |  1996-05-01  |  3KB  |  114 lines
  1. /*
  2.      File:        TextInputSystem.idl
  3.  
  4.      Contains:    The handling of text input user interface.
  5.  
  6.      Version:    Technology:    System 8
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __TEXTINPUTSYSTEM_IDL__
  19. #define __TEXTINPUTSYSTEM_IDL__
  20.  
  21. #include <somobj.idl>
  22. #include <somcls.idl>
  23.  
  24. #ifndef __TYPES_IDL__
  25. #include <Types.idl>
  26. #endif
  27. #ifndef __TEXTCOMMON_IDL__
  28. #include <TextCommon.idl>
  29. #endif
  30. #ifndef __LOCALEOBJECTS_IDL__
  31. #include <LocaleObjects.idl>
  32. #endif
  33.  
  34. #ifdef __SOMIDL__
  35.  
  36. #if FOR_SYSTEM8_COOPERATIVE
  37. /*____________________________________________________________________________________*/
  38. /*
  39.  
  40. Routine:    GetCurrentTextInputLocaleIdentifier
  41.             gets the LocaleIdentifier of the currently selected text input object.
  42. Input:        NONE.
  43. Output:        langRegionCode: the currently selected object.
  44. OSStatus:    (no error, ?)
  45. NOTE:        System8 only.
  46.  
  47. */
  48. /*____________________________________________________________________________________*/
  49. /*
  50.  
  51. Routine:    GetCurrentTextInputRef
  52.             gets the current text input object reference.
  53. Input:        NONE.
  54. Output:        textInputObject: the currently selected object.
  55. OSStatus:    (no error, ?)
  56. NOTE:        System8 only.
  57. */
  58. /*____________________________________________________________________________________*/
  59. /*
  60.  
  61. Routine:    SetCurrentTextInputLocaleIdentifier
  62.             sets the current text input object according to the passed-in LocaleIdentifier.
  63. Input:        textInputObject: the object selected by the client.
  64. Output:        NONE.
  65. OSStatus:    (no error, invalide object)
  66. NOTE:        if the object is not shown, it will be displayed in the menu if the system supports
  67.             this language/region/... locale.
  68.  
  69. */
  70. /*____________________________________________________________________________________*/
  71. /*
  72.  
  73. Routine:    SetCurrentTextInputRef
  74.             sets the current text input object ref.
  75. Input:        textInputObject: the object selected by the client.
  76. Output:        NONE.
  77. OSStatus:    (no error, invalide object)
  78. NOTE:        if the object is not shown, it will be displayed in the menu if the system supports
  79.             this language/region/... locale.
  80. */
  81. /*
  82. ____________________________________________________________________________________
  83.     routines for converting between a text input object ref and the new LocaleIdentifier
  84. ____________________________________________________________________________________
  85. */
  86. /*
  87.  
  88. Routine:    GetLocaleIdentifierFromTextInputObjectRef
  89.             returns the LocaleIdentifier textInputObject represents.
  90. Input:        textInputObject:    the reference of text input object.
  91. Output:        langRegionCode:        localeIdentifier that this objects is stamped with.
  92. OSStatus:    (no error, ?)
  93. NOTE:        System8 only.
  94.  
  95. */
  96. /*____________________________________________________________________________________*/
  97. /*
  98.  
  99. Routine:    GetTextInputObjectRefFromLocaleIdentifier
  100.             gets the object ref last designated by the user as representing the lanaguag/region
  101.             LocaleIdentifier (or simply returns the default one), otherwise it returns null.
  102. Input:        langRegioncode:        value of LocaleIdentifier.
  103. Output:        textInputObject:    best match returned object.
  104. OSStatus:    (no error, ?)
  105. NOTE:        System8 only.
  106.  
  107. */
  108. #endif
  109.  
  110. #endif /* __SOMIDL__ */
  111.  
  112. #endif /* __TEXTINPUTSYSTEM_IDL__ */
  113.  
  114.